Send Message
This section describes how you can send messages via Sinch India Conversation API. The message endpoint is used as the primary endpoint of the API, and this is where all the messages are sent through.
Request type: POST
API Url: https://convapi.aclwhatsapp.com/v1/projects/projectId/messages:send
S.No. | Attribute | Required | Datatype | Details |
---|---|---|---|---|
1 | app_id | Yes | String | The ID of the app sending the message. |
2 | recipient | Yes | Object | Contains the channel and end user identity details. |
2.1 | identified_by | Yes | Object | Contains the channel and end user identity details. |
2.1.1 | channel_identities | Yes | Array of objects | Contains all the channels, including fallback ones, and their corresponding MSISDNs |
2.1.1.1 | identity | Yes | String | Starting with country code followed by the mobile number. e.g. |
"919876543210" | ||||
2.1.1.2 | channel | Yes | String | The identifier of the channel you want to include. Must be one of the enum values. Enum: "WHATSAPP", "RCS", "SMS". In case of fallback, it should contain all the channels (part of fallback) and their corresponding user MSISDN. |
3 | message | Yes | Object | Card Message (object) or Carousel Message (object) or Choice Message (object) or Location message (object) or Media message (object) or Template Message (object) or Text message (object) or List Message (object). How and which object to be used from above is explained for all message types in all channels and fallback in later sections. |
4 | Callback_ url | No | String | Overwrites the default callback url for delivery receipts for this message. |
5 | channel_priority_order | No | Array of strings | Explicitly define the channels and order in which they are tried when sending the message. Which channels the API will try and their priority is defined by: 1. channel_priority_order if available. 2. recipient.identified_by channel_identities if available. Items Enum: "WHATSAPP" "RCS" "SMS" |
6 | message_metadata | No | String | Metadata that should be associated with the message. Returned in the metadata field of a Message Delivery Receipt. Up to 1024 characters long. |